/**
 * Copyright 2008 Matthew DeLambo
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.delambo.drool.interfaces;

import java.sql.*;
import java.util.*;

/**
 * Spins a new timer thread at a fixed rate that manages and cleans nodes in a 
 * pool.
 * @author delambo
 */
public interface CleanerThread<NODE extends PoolNode> {

    interface Factory {
        CleanerThread create(PropertyMap props, DataSource ds, 
                AtomicLockingArray ala);
    }
    
    /**
     * Starts this thread on a timer.
     */
    public void startTimer();
    
    /**
     * Starts this cleaning thread.
     */
    public void run();
    
    /**
     * Stops this cleaning thread.
     * @return true if thread was cancelled without exception; false, otherwise.
     */
    public boolean cancel();
    
}
